7.1 创建外部用户角色
基本信息
Path: /api/v2/externalUserRole/create
Method: POST
接口描述:
- 创建一个外部用户角色
- 如需对角色进行应用授权,可使用编辑接口:
/api/v2/externalUserRole/update
- 需要关联"适用对象"->"组织架构"时,使用
groupNameList
可能导致关联到多个同名组织架构,后续将不再维护此参数,建议使用groupFullPathList
作为替代
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 必须 |
Body
- 部分参数,如关联对象ID,需要通过在控制台手动获取,以Chrome浏览器为例,获取方式为F12打开“开发者工具”,在Network中找到对应对象的查询接口手动获取该对象的ID
- 用户目录ID,userDirectoryId获取方式,用“开发者工具”过滤请求 userDirectory/queryAll,打开控制台“业务管理”->“用户与角色”(原“用户管理”)页面,查看响应体数据获取对应用户目录的ID,也可以通过用户目录查询接口获取ID
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string[] | 必须 | 角色名列表,该接口允许批量创建角色 | ||
userDirectoryId | string | 与userDirectoryName二选一 | 所属用户目录ID | userDirectoryId和userDirectoryName只传一个即可,都传时以userDirectoryId为准 | |
userDirectoryName | string | 与userDirectoryId二选一 | 所属用户目录名称 | userDirectoryId和userDirectoryName只传一个即可,都传时以userDirectoryId为准 | |
description | string | 非必须 | 描述 | ||
userIdList | string[] | 非必须 | 用户ID列表 | userIdList与userNameList只传一个即可,都传时以userIdList为准 | |
userNameList | string[] | 非必须 | 用户名称列表 | userIdList与userNameList只传一个即可,都传时以userIdList为准 | |
groupIdList | string[] | 非必须 | 适用对象-组织架构ID列表 | 与groupNameList、groupFullPathList只传一个即可,传多个参数时优先级为:groupIdList > groupFullPathList > groupNameList | |
groupFullPathList | string[] | 非必须 | 适用对象-组织架构全路径列表,如:["/a/b", "/a/c"] | 与groupIdList、groupNameList只传一个即可 | |
groupNameList | string[] | 非必须 | (该字段不再维护)适用对象-组织架构名列表,如:["b", "c"] | 与groupIdList、groupFullPathList只传一个即可 |
请求示例
{
"userDirectoryName": "LDAP用户目录",
"name": [
"role2"
],
"description": "role2-desc",
"userNameList": [
"张三"
]
}
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 错误码,非0表示错误,具体含义请参考错误码定义 | ||
data | string[] | 必须 | 角色ID | ||
msg | string | 必须 | 描述信息 |
返回示例
{
"code": 0,
"data":["574229e0-d19c-11ec-b981-25f35dfc3047"],
"msg": "请求成功",
"traceId": "0321d1efe3801000"
}
错误信息
错误提示 | 错误码 |
---|---|
组织架构格式错误,路径需以/开头,且不能存在//或以/结尾 | 7201 |
参数检查出错 | 10000001 |
用户目录不存在 | 77200001 |
用户目录不存在 | 77200004 |
角色名称(%s)已存在 | 77200005 |
部分用户数据已经删除,请重新选择 | 10000001 |
外部组织架构不存在 | 7201 |
服务器内部错误 | 10000000 |